home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / prescan.zip / PRESCAN.DOC < prev    next >
Text File  |  1993-01-03  |  17KB  |  520 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                             PreScan (tm)
  8.                           Version 2.11.00
  9.  
  10.  
  11.  
  12.  
  13.                             
  14.                  Copyright (c) 1992, 93, Jeff Hasz
  15.                         All Rights Reserved
  16.  
  17.  
  18.  
  19.  
  20.  Page i                                                              PreScan
  21.  
  22.                               Forward
  23.                               
  24.         I'll try to be brief here, in my forward, but I would like
  25.         to thank a few people for helping make PreScan a reality.
  26.         
  27.         First, I'd like to thank my wife for putting up with me 
  28.         working into the wee smalls, and my daughter, Sara, who
  29.         corageously puts up with my rantings.  They are both a
  30.         fountain of inspiration to me.
  31.         
  32.         Secondly, I'd like to thank Laughlin (you know who you
  33.         are) for the patience to test this thing and await the 
  34.         next beta release while I was implementing and debugging
  35.         the excellent suggestions you gave me for improving 
  36.         PreScan.  (Next thing I work on L is better doc 
  37.         formatting, OK?)
  38.         
  39.         And finally, to my former employer, who, in a surprise
  40.         decision, gave me the time to get those creative juices 
  41.         flowing again, without which, I would never have even 
  42.         conceived of PreScan let alone had time or energy to create
  43.         it. 
  44.         
  45.         There, I think that's short enough...
  46.         
  47.         Enjoy,
  48.         
  49.  
  50.         Jeff  -  November 1992
  51.         
  52.  
  53.  Page 1                                                              PreScan
  54.  
  55.  
  56.         Hello, first a word of advice, if you are viewing this with your
  57.         text based word processor, you will have to set your tabs to 
  58.         four.  This document was save with actual tabs in it. if you 
  59.         wish them to be spaces you will have to edit it and place four
  60.         spaces for every tab. 
  61.  
  62.         First off, these are the files you should have received in the
  63.         PRESCAN.ZIP:
  64.         
  65.             PRESCAN.EXE                The PreScan executable.
  66.             
  67.             PRESCAN.CFG                A sample configuration file.
  68.             
  69.             PRESCAN.BAT                A sample prescan.bat file.
  70.             
  71.             PRESCAN.DOC                This documentation file.
  72.             
  73.  
  74.         Additional Files you will receive upon registering your copy
  75.         of PreScan:
  76.         
  77.             DAYERR.EXE                A program to generate a errorlevel
  78.                                     based on the current day.
  79.             
  80.         
  81.         I will quote myself:
  82.  
  83.         "However, if enough respondants request that PreScan be made
  84.         available as a stand alone door program, I will incorporate
  85.         all of the required code to make it a stand alone door program."
  86.         
  87.         Well it's here!  PreScan V 2.0.0!  Now New! Improved! (oops,
  88.         sorry, I'm getting carried away).
  89.         
  90.         But it is here...Prescan, version 2.  Now a stand-alone door
  91.         program.
  92.         
  93.         Please feel free to support this shareware development effort 
  94.         through the registration proceedure and through your comments.
  95.         
  96.         
  97. Page 2                                                               PreScan
  98.  
  99.         Contents:
  100.         
  101.             Packing manifest................................ 1
  102.             Table of Contents............................... 2
  103.             Terms and Conditions............................ 3
  104.             Restrictions.................................... 3
  105.             Introduction.................................... 4
  106.             Installation.................................... 4
  107.             Configuration................................... 5
  108.             Configuring the PRESCAN.BAT file................ 6
  109.             The PRESCAN.HLP file............................ 7
  110.             Why Should I Register?.......................... 8
  111.             Registration Form............................... 9
  112.             Appendix A......................................10
  113.             Appendix B......................................11
  114.             
  115.  
  116.  
  117. Page 3                                                               PreScan
  118.  
  119.     Terms and Conditions:
  120.     
  121.         PreScan is a shareware package.  To those of you who don't 
  122.         know or have a vague idea what this means, read on.  
  123.         Otherwise, skip to the next section.  Shareware is software 
  124.         you may "share" with your friends and colleagues.  You may 
  125.         use PreScan as much as you wish for up to 45 days with 
  126.         absolutely no obligation to buy it.  But shareware isn't 
  127.         free. You must pay for PreScan if you decide to use it past 
  128.         45 days.  The initial charge for PreScan is $21, which now
  129.         includes printed documentation and a registered diskette.  
  130.         This is a departure from version 1 where it was a bit less 
  131.         expensive but did not include printed documentation and disks.
  132.         Registering PreScan still includes free upgrades to the 
  133.         software for up to 1 year.
  134.  
  135.         The copy of PreScan you have is not crippled, and hopefully 
  136.         it isn't "annoyware."   
  137.  
  138.     Restrictions:
  139.  
  140.         You have obtained a copy of a shareware package, which means 
  141.         you may let your friends and colleagues have a copy if you 
  142.         wish, as long as you abide by the following restrictions:
  143.  
  144.             1.  You do not charge for the transfer of PreScan or any 
  145.                 of its components.
  146.  
  147.             2.  You supply the exact files and packaging for the 
  148.                 shareware version of PreScan that you obtained 
  149.                 electronically or by other means.
  150.  
  151.             3.  You DO NOT share the licensing information provided 
  152.                 once you register PreScan.
  153.  
  154.         The author, Jeff Hasz, makes no claim as to the viability or
  155.         usefulness of the product to suit particular needs.  Use the 
  156.         product initially for no charge, and when the test drive is 
  157.         over, decide if you like it and register it if you do.
  158.  
  159.         PreScan is copyrighted property developed by Jeff Hasz.
  160.  
  161.  
  162.  
  163.  
  164. Page 4                                                               PreScan
  165.  
  166.         Introduction:
  167.         
  168.             PreScan was conceived as a timesaving program for the 
  169.             Ship to Shore On-Line Information Service to allow some
  170.             user maintenance.
  171.             
  172.             It allows the on-line user to select to have his mail
  173.             packets prepared for him prior to his logging onto your 
  174.             system.
  175.             
  176.             This is done by calling the mail door through the
  177.             PRESCAN.BAT file and allowing it to create individual
  178.             mail packet files for each listed user.
  179.             
  180.             It was originally created to run under the WildCat! 
  181.             BBS system with the Tomcat! mail door.  It has not been
  182.             fully tested with any other mail door yet.  (read, "Any 
  183.             volunteers out there?")
  184.             
  185.             It has the capability to support almost any mail door
  186.             that supports prescanned packets.
  187.             
  188.             Finally, PreScan REQUIRES the use of a fossil driver to 
  189.             work, it has been tested with X00.
  190.             
  191.         Installation:
  192.         
  193.             PreScan should be installed in the same directory that
  194.             your BBS software is.  This is not mandatory, but it 
  195.             helps keep things straight.
  196.             
  197.             PRESCAN.HLP _must_ reside in the same directory as
  198.             PRESCAN.EXE as this is where PRESCAN.EXE looks for
  199.             the help file.
  200.             
  201.             The PRESCAN.CFG file _must_ be installed in the same
  202.             directory as PRESCAN.EXE.  PreScan looks for the 
  203.             configuration file in the same place that it exists.
  204.             
  205.             The configuration file contains information needed 
  206.             by PreScan to determine where the CALLINFO.BBS file 
  207.             and the PRESCAN.BAT file are located as well as the 
  208.             actual name of the CALLINFO file (Some BBS's create a
  209.             file called PCBOARD.BBS or DORINFO.DEF).
  210.             
  211.             It also contains information about what line(s) the 
  212.             user name is located as well as where to find the baud
  213.             rate and the COM port.
  214.             
  215.             Also in this file is the name of the mail door you are 
  216.             using and the format that it is called with.
  217.  
  218.  
  219.  
  220. Page 5                                                               PreScan
  221.  
  222.         Configuration:
  223.         
  224.             Ok, so now you have the files all unpacked, so now it's 
  225.             time to set up the configuration of PreScan.
  226.             
  227.             Below is a sample PRESCAN.CFG file.  A discussion of
  228.             each line will follow.
  229.         
  230.             d:\wc30\callinfo.bbs
  231.             d:\wc30\
  232.             1, 1, 29, 31
  233.             tomcat %s /prescan
  234.             tomcat
  235.             d:\wc30\
  236.             
  237.             Ok, clear as mud, right?
  238.             
  239.             The first line is the line that contains the path and 
  240.             file name of the "callinfo" file.  For WC! this *will*
  241.             be CALLINFO.BBS (boy those guys as MSI think of 
  242.             everything!).  This could be PCBOARD.DEF or something
  243.             else that some BBS author dreams up.
  244.             
  245.             The second line indicates where the PRESCAN.BAT file 
  246.             is located.
  247.             
  248.             The third line contain the line number in the "callinfo"
  249.             file that has the users first name and second name 
  250.             respectively.
  251.             
  252.             Also in the third line are the line numbers for the COM
  253.             port and the modem speed (baud rate).
  254.             
  255.             The fourth line is the format line for how your mail
  256.             door is called for creating prescan packets.
  257.             
  258.             The fifth line is the name of your mail door (this 
  259.             should be the same as the first word of the line 
  260.             preceeding it in the file i.e. the fourth line).
  261.             
  262.             The final line MUST exist, even if it's blank.  If this
  263.             line is left blank then no logging will occur.  To 
  264.             institute logging of the additions to your PRESCAN.BAT
  265.             file, put the path to where you want the log file to
  266.             be placed here.
  267.             
  268.             Once you have this file created and setup properly
  269.             you can test the door with your PRESCAN.BAT file to
  270.             determine if it is setup correctly.
  271.  
  272.  
  273.  
  274. Page 6                                                               PreScan
  275.             
  276.             However, this supposes that you have created a minimal 
  277.             PRESCAN.BAT file already.  And you do know how to do 
  278.             that, don't you?  Oh that's right.  I haven't explained
  279.             that part yet...Ok, I'll get on with it.
  280.             
  281.  
  282.         Configuring the PRESCAN.BAT file:
  283.  
  284.             The correct format for the PRESCAN.BAT file is as
  285.             follows:
  286.             
  287.             @echo off
  288.             c:
  289.             cd \wc30
  290.             dayerr nnn        /*  This line exists only for registered versions  */
  291.                             /*  nnn = the number to start your error level at  */
  292.                              /*  in this example nnn would equal 10               */
  293.  
  294.             if errorlevel == 16 goto SATURDAY
  295.             if errorlevel == 15 goto FRIDAY
  296.             if errorlevel == 14 goto THURSDAY
  297.             if errorlevel == 13 goto WEDNESDAY
  298.             if errorlevel == 12 goto TUESDAY
  299.             if errorlevel == 11 goto MONDAY
  300.             if errorlevel == 10 goto SUNDAY   
  301.             :SUNDAY
  302.             goto DAILY
  303.             :MONDAY
  304.             goto DAILY
  305.             :TUESDAY
  306.             goto DAILY
  307.             :WEDNESDAY
  308.             goto DAILY
  309.             :THURSDAY
  310.             goto DAILY
  311.             :FRIDAY
  312.             goto DAILY
  313.             :SATURDAY
  314.             :DAILY
  315.             tomcat sysop /download
  316.             tomcat JOHN SMITH /prescan
  317.             d:
  318.             cd \fd
  319.             
  320.  
  321.  
  322. Page 7                                                               PreScan
  323.  
  324.  
  325.             You *must* begin with at least one call to your mail
  326.             door already in place (see appendix A).
  327.             
  328.             The labeled points are required only for the registered
  329.             version...<hint, hint>...If you don't run the registered
  330.             version, then you can leave them out.  But if you
  331.             decide to register your PreScan (and I hope you will), 
  332.             you will need to put them back in.
  333.             
  334.             If you have the registered version of PreScan, the 
  335.             labels are required and they are required to be in the
  336.             order shown (you can use the sample PRESCAN.BAT file
  337.             supplied as a beginning).
  338.             
  339.             I trust that the rest of this file will be self
  340.             explanatory.
  341.             
  342.         The PRESCAN.HLP File:
  343.         
  344.             You can edit this file to reflect you own systems 
  345.             attitude or flavor. 
  346.             
  347.             Simply use an editor that will write a flat text 
  348.             file for output.
  349.             
  350.             If you need more than one screen of help information,
  351.             simply place a @PAUSE on a line by itself with the '@'
  352.             in the very first column.
  353.             
  354.             This will pause the output at that line and print
  355.             
  356.             [C]ontinue, [S]top...[C] 
  357.             
  358.             at the bottom of the screen.  If the user has read 
  359.             enough of the help text, thay can elect to stop and 
  360.             return to the option selection menu.  Otherwise, 
  361.             selecting continue will display the balance of the text
  362.             upto the end of the help file or the next @PAUSE, 
  363.             whichever comes first.
  364.             
  365.  
  366.  
  367. Page 8                                                               PreScan
  368.  
  369.         Registration:
  370.         
  371.             Please register PreScan if you find it helpful in 
  372.             your BBS maintanance.  It will help promote further
  373.             enhancements and other new, useful doors that I might
  374.             develop.  It also might inspire me to add features to
  375.             Prescan or create other good, easy-to-run programs for
  376.             us sysop types.
  377.             
  378.             Remember that if you don't register it, I absoulutely
  379.             will *NOT* tolerate any mail, phone calls, etc. that
  380.             are whiney, nasty, or complaining from you. Constructive 
  381.             suggestions are always welcome.
  382.             
  383.             However, if you do register I will welcome any thoughts
  384.             about improving PreScan.
  385.             
  386.             Registration is truly a bargain at $21.00 US plus $3.00 
  387.             S + H and brings with it many benefits.  Some of which 
  388.             are notification of free upgrades (downloadable from 
  389.             my system), a typeset, printed manual, and the *now* 
  390.             available, multi-day option (See appendix A and thanks 
  391.             Laughlin).  None-the-less, it is still a bargain.  
  392.             And I will appreciate it.
  393.             
  394.             Site licensing and multiple copy discounts are
  395.             available.  Write to the address below for further
  396.             details.
  397.             
  398.  
  399.  
  400. Page 9                                                               PreScan
  401.  
  402.     Registration Form:
  403.     
  404.     Name:____________________________________________________________
  405.     
  406.     Address:_________________________________________________________
  407.     
  408.     City:______________________________ State:______ Zip:____________
  409.     
  410.     Version of PreScan you have:_________________
  411.     
  412.     Copies you wish to register:_____
  413.     
  414.                             *   $21.00
  415.                                 =======
  416.                             =    
  417.                                 =======
  418.                             +    $ 3.00  Shipping and Handling
  419.                                 =======
  420.                     Total:
  421.  
  422.     Mail to:
  423.     
  424.     Jeff Hasz
  425.     5000 Carriage Way Drive
  426.     Suite 109
  427.     Rolling Meadows, IL  60008
  428.     
  429.     Thank you,
  430.     
  431.     Jeff Hasz.
  432.  
  433.  
  434. Page 10                                                              PreScan
  435.  
  436.  
  437.                              Appendix A
  438.  
  439.         This appendix is to describe some of the additional features
  440.         that you will receive with a registered copy of PreScan.
  441.         
  442.         The biggie feature that will be available to you will be the
  443.         ability of users to select a single day, combination of days 
  444.         or every day of the week to have the prescan packet made up
  445.         for them.  This also requires another file, which you will 
  446.         receive from me when I receive your registration.
  447.         
  448.         To illustrate:
  449.         
  450.         A user calls once a week and would like to get the mail for
  451.         the echos/conferences he reads for the whole week.  He simply
  452.         selects the day to perform the prescan on every week and 
  453.         PreScan will create his .QWK file on that day, to be ready
  454.         for when he calls.
  455.         
  456.         Other minor advantages are a typeset, printed manual and
  457.         notification of new versions (and other software that I 
  458.         might develop).
  459.         
  460.         Another benefit of registration is that you may be given 
  461.         the option of becoming a Beta test site for upgrades/new
  462.         software and you will get to see/have the new stuff first!
  463.         This is hightened by one of the rewards of Beta testing
  464.         which is a registered copy of the tested software, free, or
  465.         if you are already a registered user and are testing an up-
  466.         grade, a selection from our catalog (when we develop other
  467.         packages! ;-))
  468.         
  469.         Also, you will now you are supporting the development of 
  470.         new and timesaving software for your use at a reasonable 
  471.         cost.  (I'll appreciate it, too!)
  472.         
  473.         Thanks for your support of the shareware concept.
  474.         
  475.         Jeff Hasz
  476.         1:115/670  (fido)
  477.         
  478.  
  479.  
  480. Page 11                                                              PreScan
  481.  
  482.  
  483.                              Appendix B
  484.         
  485.     Features Summary:
  486.     
  487.         There are a number of features in this release of PreScan
  488.         that are not completely intuitive.  These include the
  489.         capability of running it locally and, in the registered
  490.         version, the ability to scan by indivdual days, as well as
  491.         daily.
  492.         
  493.         To run PreScan locally, from the command line type:
  494.         
  495.                 PRESCAN B0 <ENTER>
  496.                 
  497.         This will run PreScan in a stand alone mode locally.
  498.         
  499.         
  500.         To implement the individual scans (including daily), the 
  501.         PRESCAN.BAT file must be created in the same manner as the 
  502.         example given previously.  This will ensure that all the 
  503.         days are accounted for, and that after each individual days
  504.         worth of users packets have been created it will create 
  505.         those whose packets are "daily" packets.
  506.         
  507.         After the PRESCAN.BAT file has been created in this manner,
  508.         an event must be created that will exits with a specific
  509.         errorlevel.  This can be done in Front Door, Wildcat,
  510.         and many of the other mailers and BBS packages around.
  511.         
  512.         Call the PRESCAN.BAT file by calling it    from CAT.BAT (or 
  513.         other batch file) in the following manner:
  514.         
  515.         PRESCAN.BAT
  516.         
  517.         The PRESCAN.BAT file, if created correctly, will handle the 
  518.         rest.
  519.         
  520.